Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RST-formatted documentation, guides, and related bug fixes #162

Draft
wants to merge 63 commits into
base: main
Choose a base branch
from

Conversation

aholmes
Copy link
Member

@aholmes aholmes commented Nov 19, 2024

No description provided.

@aholmes aholmes added the documentation Improvements or additions to documentation label Nov 19, 2024
@aholmes aholmes self-assigned this Nov 19, 2024
@aholmes aholmes changed the title RST-formatter documentation, guides, and related bug fixes RST-formatted documentation, guides, and related bug fixes Nov 19, 2024
@aholmes aholmes force-pushed the aholmes-add-documentation branch from 0cd68bf to ab0dd49 Compare November 19, 2024 23:58
@aholmes aholmes force-pushed the aholmes-add-documentation branch from 3a7c9e7 to 1667a5e Compare November 20, 2024 22:01
@aholmes aholmes added the blocked Blocked by other issues label Jan 6, 2025
@aholmes
Copy link
Member Author

aholmes commented Jan 6, 2025

Blocked on #165. Correct documentation cannot be written about building an application until the PR is merged.

@aholmes aholmes removed the blocked Blocked by other issues label Jan 10, 2025
* Ligate.AWS (incomplete)
* Ligare.GitHub (incomplete)
* Ligare.database
* Ligare.identity (incomplete)
* Ligare.platform (incomplete)
* Ligare.testing
* Ligare.web
This class is partly a copy of the application builder in Ligare.web,
but more generic. This is a precursor to further refactoring and
changing Ligare.web to use the Ligare.programming builder.
This is a breaking change to remove the previously deprecated
`create_app` and `App[T].create_app` functions. Use
`ApplicationBuilder`.
…rogramming`.

This change is necessary to allow non-web applications like CLI apps.
@aholmes aholmes force-pushed the aholmes-add-documentation branch from 3e82865 to 231415f Compare January 10, 2025 21:37
* Move the builder exception types from Ligare.web to Ligare.programming
* Guard against loading Ligare.AWS if it's not installed
* Add toml to Ligare.programming's dependencies
web Config type by default.

Also remove the `with_root_config_type` method to simplify the builder
and prevent misuse. This change is needed so application authors don't
need to do this, and this is safe because web applications all use the
web Config type as their root config.
This allows web applications to rely on the config system to set the
application name rather than relying on hard-coding it.
When the Swagger URL is `/` or ``, the application crashes on any
request. This is because Connxeion registers conflicting Blueprint URLs
for anything in the OpenAPI spec by using the same base URL as the Swagger
URL. This is not resolved by changing the base path in the OpenAPI spec,
because Connexion will use that base path instead.

Also removed some obsolete and unused code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant